/*
 * @(#)XfslAlgorithmParam.java        1.0 2000/05/09
 *
 * This file is part of Xfuzzy 3.0, a design environment for fuzzy logic
 * based systems.
 *
 * (c) 2000 IMSE-CNM. The authors may be contacted by the email address:
 *                    xfuzzy-team@imse.cnm.es
 *
 * Xfuzzy is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by
 * the Free Software Foundation.
 *
 * Xfuzzy is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * for more details.
 */

package xfuzzy.xfsl.model;


/**
 * Clase que describe el par�metro de control de un algoritmo de aprendizaje
 * 
 * @author Francisco Jos� Moreno Velo
 *
 */
public class XfslAlgorithmParam {

	//----------------------------------------------------------------------------//
	//                            MIEMBROS PRIVADOS                               //
	//----------------------------------------------------------------------------//

	/**
	 * Valor del par�metro
	 */
	private double value;

	/**
	 * Valor por defecto del par�metro
	 */
	private double defaultValue;
	
	/**
	 * Tip� de par�metro
	 */
	private int test;
	
	/**
	 * Nombre del par�metro
	 */
	private String name;

	//----------------------------------------------------------------------------//
	//                                CONSTRUCTOR                                 //
	//----------------------------------------------------------------------------//

	/**
	 * Constructor
	 */
	public XfslAlgorithmParam(double value, double defvalue, int test, String name) {
		this.value = value;
		this.defaultValue = defvalue;
		this.test = test;
		this.name = name;
	}

	//----------------------------------------------------------------------------//
	//                             M�TODOS P�BLICOS                               //
	//----------------------------------------------------------------------------//

	/**
	 * Obtiene el valor del par�metro
	 */
	public double getValue() {
		return this.value;
	}

	/**
	 * Obtiene el valor por defecto del par�metro
	 */
	public double getDefaultValue() {
		return defaultValue;
	}

	/**
	 * Obtiene el tipo de par�metro
	 */
	public int getKind() {
		return test;
	}

	/**
	 * Obtiene el nombre del par�metro
	 * @return
	 */
	public String getName() {
		return this.name;
	}
}
